home *** CD-ROM | disk | FTP | other *** search
/ Aminet 48 / Aminet 48 (2002)(GTI - Schatztruhe)[!][Apr 2002].iso / Aminet / text / edit / vim60rt.lha / Vim / vim60 / doc / cmdline.txt < prev    next >
Encoding:
Text File  |  2001-09-26  |  37.6 KB  |  941 lines

  1. *cmdline.txt*   For Vim version 6.0.  Last change: 2001 Sep 16
  2.  
  3.  
  4.           VIM REFERENCE MANUAL    by Bram Moolenaar
  5.  
  6.  
  7.                 *Cmdline-mode* *Command-line-mode*
  8. Command-line mode        *Cmdline* *Command-line* *mode-cmdline* *:*
  9.  
  10. Command-line mode is used to enter Ex commands (":"), search patterns
  11. ("/" and "?"), and filter commands ("!").
  12.  
  13. Basic command line editing is explained in chapter 20 of the user manual
  14. |usr_20.txt|.
  15.  
  16. 1. Command-line editing        |cmdline-editing|
  17. 2. Command-line completion    |cmdline-completion|
  18. 3. Ex command-lines        |cmdline-lines|
  19. 4. Ex command-line ranges    |cmdline-ranges|
  20. 5. Ex special characters    |cmdline-special|
  21. 6. Command-line window        |cmdline-window|
  22.  
  23. ==============================================================================
  24. 1. Command-line editing                    *cmdline-editing*
  25.  
  26. Normally characters are inserted in front of the cursor position.  You can
  27. move around in the command-line with the left and right cursor keys.  With the
  28. <Insert> key, you can toggle between inserting and overstriking characters.
  29. {Vi: can only alter the last character in the line}
  30.  
  31. Note that if your keyboard does not have working cursor keys or any of the
  32. other special keys, you can use ":cnoremap" to define another key for them.
  33. For example, to define tcsh style editing keys:        *tcsh-style*  >
  34.     :cnoremap <C-A> <Home>
  35.     :cnoremap <C-F> <Right>
  36.     :cnoremap <C-B> <Left>
  37.     :cnoremap <Esc>b <S-Left>
  38.     :cnoremap <Esc>f <S-Right>
  39. (<> notation |<>|; type all this literally)
  40.  
  41.                             *cmdline-too-long*
  42. When the command line is getting longer than what fits on the screen, only the
  43. part that fits will be shown.  The cursor can only move in this visible part,
  44. thus you cannot edit beyond that.
  45.  
  46.                         *cmdline-history* *history*
  47. The command-lines that you enter are remembered in a history table.  You can
  48. recall them with the up and down cursor keys.  There are actually four
  49. history tables:
  50. - one for ':' commands
  51. - one for search strings
  52. - one for expressions
  53. - one for input lines, typed for the |input()| function.
  54. These are completely separate.  Each history can only be accessed when
  55. entering the same type of line.
  56. Use the 'history' option to set the number of lines that are remembered
  57. (default: 20).
  58. Notes:
  59. - When you enter a command-line that is exactly the same as an older one, the
  60.   old one is removed (to avoid repeated commands moving older commands out of
  61.   the history).
  62. - Only commands that are typed are remembered.  Ones that completely come from
  63.   mappings are not put in the history
  64. - All searches are put in the search history, including the ones that come
  65.   from commands like "*" and "#".  But for a mapping, only the last search is
  66.   remembered (to avoid that long mappings trash the history).
  67. {Vi: no history}
  68. {not available when compiled without the |+cmdline_hist| feature}
  69.  
  70. There is an automatic completion of names on the command-line; see
  71. |cmdline-completion|.
  72.  
  73.                             *c_CTRL-V*
  74. CTRL-V        Insert next non-digit literally.  Up to three digits form the
  75.         decimal value of a single byte.  The non-digit and the three
  76.         digits are not considered for mapping.  This works the same
  77.         way as in Insert mode (see above, |i_CTRL-V|).
  78.         Note: Under Windows CTRL-V is often mapped to paste text.
  79.         Use CTRL-Q instead then.
  80.                             *c_CTRL-Q*
  81. CTRL-Q        Same as CTRL-V.
  82.  
  83.                             *c_<Left>*
  84. <Left>        cursor left
  85.                             *c_<Right>*
  86. <Right>        cursor right
  87.                             *c_<S-Left>*
  88. <S-Left> or <C-Left>                    *c_<C-Left>*
  89.         cursor one WORD left
  90.                             *c_<S-Right>*
  91. <S-Right> or <C-Right>                    *c_<C-Right>*
  92.         cursor one WORD right
  93. CTRL-B or <Home>                    *c_CTRL-B* *c_<Home>*
  94.         cursor to beginning of command-line
  95. CTRL-E or <End>                        *c_CTRL-E* *c_<End>*
  96.         cursor to end of command-line
  97.  
  98.                             *c_<LeftMouse>*
  99. <LeftMouse>    cursor to position of mouse click.
  100.  
  101. CTRL-H                            *c_<BS>* *c_CTRL-H*
  102. <BS>        delete the character in front of the cursor (see |:fixdel| if
  103.         your <BS> key does not do what you want).
  104.                             *c_<Del>*
  105. <Del>        delete the character under the cursor (at end of line:
  106.         character before the cursor) (see |:fixdel| if your <Del>
  107.         key does not do what you want).
  108.                             *c_CTRL-W*
  109. CTRL-W        delete the word before the cursor
  110.                             *c_CTRL-U*
  111. CTRL-U        remove all characters between the cursor position and
  112.         the beginning of the line.  Previous versions of vim
  113.         deleted all characters on the line.  If that is the
  114.         preferred behavior, add the following to your .vimrc: >
  115.             :cnoremap <C-U> <C-E><C-U>
  116. <
  117.         Note: if the command-line becomes empty with one of the
  118.         delete commands, Command-line mode is quit.
  119.                             *c_<Insert>*
  120. <Insert>    Toggle between insert and overstrike.  {not in Vi}
  121.  
  122. {char1} <BS> {char2}    or                *c_digraph*
  123. CTRL-K {char1} {char2}                    *c_CTRL-K*
  124.         enter digraph (see |digraphs|).  When {char1} is a special
  125.         key, the code for that key is inserted in <> form.  {not in Vi}
  126.  
  127. CTRL-R {0-9a-z"%#:-=.}                    *c_CTRL-R* *c_<C-R>*
  128.         Insert the contents of a numbered or named register.  Between
  129.         typing CTRL-R and the second character '"' will be displayed
  130.         to indicate that you are expected to enter the name of a
  131.         register.
  132.         The text is inserted as if you typed it, but mappings and
  133.         abbreviations are not used.  Command-line completion through
  134.         'wildchar' is not triggered though.  And characters that end
  135.         the command line are inserted literally (<Esc>, <CR>, <NL>,
  136.         <C-C>).  A <BS> or CTRL-W could still end the command line
  137.         though, and remaining characters will then be interpreted in
  138.         another mode, which might not be what you intended.
  139.         Special registers:
  140.             '"'    the unnamed register, containing the text of
  141.                 the last delete or yank
  142.             '%'    the current file name
  143.             '#'    the alternate file name
  144.             '*'    the clipboard contents
  145.             '/'    the last search pattern
  146.             ':'    the last command-line
  147.             '-'    the last small (less than a line) delete
  148.             '.'    the last inserted text
  149.             '='    the expression register: you are prompted to
  150.                 enter an expression (see |expression|)
  151.         See |registers| about registers.  {not in Vi}
  152.  
  153. CTRL-R CTRL-F                *c_CTRL-R_CTRL-F* *c_<C-R>_<C-F>*
  154. CTRL-R CTRL-P                *c_CTRL-R_CTRL-P* *c_<C-R>_<C-P>*
  155. CTRL-R CTRL-W                *c_CTRL-R_CTRL-W* *c_<C-R>_<C-W>*
  156. CTRL-R CTRL-A                *c_CTRL-R_CTRL-A* *c_<C-R>_<C-A>*
  157.         Insert the object under the cursor:
  158.             CTRL-F    the Filename under the cursor
  159.             CTRL-P    the Filename under the cursor, expanded with
  160.                 'path' as in |gf|
  161.             CTRL-W    the Word under the cursor
  162.             CTRL-A    the WORD under the cursor; see |WORD|
  163.         {not in Vi}
  164.         CTRL-F and CTRL-P: {only when +file_in_path feature is
  165.         included}
  166.  
  167.                     *c_CTRL-R_CTRL-R* *c_<C-R>_<C-R>*
  168.                     *c_CTRL-R_CTRL-O* *c_<C-R>_<C-O>*
  169. CTRL-R CTRL-R {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
  170. CTRL-R CTRL-O {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
  171.         Insert register or object under the cursor.  Works like
  172.         |c_CTRL-R| but inserts the text literally.  For example, if
  173.         register a contains "xy^Hz" (where ^H is a backspace),
  174.         "CTRL-R a" will insert "xz" while "CTRL-R CTRL-R a" will
  175.         insert "xy^Hz".
  176.  
  177.                             *c_CTRL-Y*
  178. CTRL-Y        When there is a modeless selection, copy the selection into
  179.         the clipboard. |modeless-selection|
  180.         If there is no selection CTRL-Y is inserted as a character.
  181.  
  182. CTRL-J                        *c_CTRL-J* *c_<NL>* *c_<CR>*
  183. <CR> or <NL>    start entered command
  184.                             *c_<Esc>*
  185. <Esc>        When typed and 'x' not present in 'cpoptions', quit
  186.         Command-line mode without executing.  In macros or when 'x'
  187.         present in 'cpoptions', start entered command.
  188.                             *c_CTRL-C*
  189. CTRL-C        quit command-line without executing
  190.  
  191.                             *c_<Up>*
  192. <Up>        recall older command-line from history, whose beginning
  193.         matches the current command-line (see below).
  194.         {not available when compiled without the |+cmdline_hist|
  195.         feature}
  196.                             *c_<Down>*
  197. <Down>        recall more recent command-line from history, whose beginning
  198.         matches the current command-line (see below).
  199.         {not available when compiled without the |+cmdline_hist|
  200.         feature}
  201.  
  202.                             *c_<S-Up>* *c_<PageUp>*
  203. <S-Up> or <PageUp>
  204.         recall older command-line from history
  205.         {not available when compiled without the |+cmdline_hist|
  206.         feature}
  207.                         *c_<S-Down>* *c_<PageDown>*
  208. <S-Down> or <PageDown>
  209.         recall more recent command-line from history
  210.         {not available when compiled without the |+cmdline_hist|
  211.         feature}
  212.  
  213. CTRL-D        command-line completion (see |cmdline-completion|)
  214. 'wildchar' option
  215.         command-line completion (see |cmdline-completion|)
  216. CTRL-N        command-line completion (see |cmdline-completion|)
  217. CTRL-P        command-line completion (see |cmdline-completion|)
  218. CTRL-A        command-line completion (see |cmdline-completion|)
  219. CTRL-L        command-line completion (see |cmdline-completion|)
  220.  
  221.                             *c_CTRL-_*
  222. CTRL-_        a - switch between Hebrew and English keyboard mode, which is
  223.         private to the command-line and not related to hkmap.
  224.         This is useful when Hebrew text entry is required in the
  225.         command-line, searches, abbreviations, etc.  Applies only if
  226.         Vim is compiled with the |+rightleft| feature and the
  227.         'allowrevins' option is set.
  228.         See |rileft.txt|.
  229.  
  230.         b - switch between Farsi and English keyboard mode, which is
  231.         private to the command-line and not related to fkmap.  In
  232.         Farsi keyboard mode the characters are inserted in reverse
  233.         insert manner.  This is useful when Farsi text entry is
  234.         required in the command-line, searches, abbreviations, etc.
  235.         Applies only if Vim is compiled with the |+farsi| feature.
  236.         See |farsi.txt|.
  237.  
  238.                             *c_CTRL-^*
  239. CTRL-^        Toggle the use of language |:lmap| mappings and/or Input
  240.         Method.
  241.         When typing a pattern for a search command and 'imsearch' is
  242.         not -1, VAL is the value of 'imsearch', otherwise VAL is the
  243.         value of 'iminsert'.
  244.         When language mappings are defined:
  245.         - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
  246.           mappings used).
  247.         - If VAL was not 1 it becomes 1, thus langmap mappings are
  248.           enabled.
  249.         When no language mappings are defined:
  250.         - If VAL is 2 (Input Method is used) it becomes 0 (no input
  251.           method used)
  252.         - If VAL has another value it becomes 2, thus the Input Method
  253.           is enabled.
  254.         These language mappings are normally used to type characters
  255.         that are different from what the keyboard produces.  The
  256.         'keymap' option can be used to install a whole number of them.
  257.         When entering a command line, langmap mappings are switched
  258.         off, since you are expected to type a command.  After
  259.         switching it on with CTRL-^, the new state is not used again
  260.         for the next command or Search pattern.
  261.         {not in Vi}
  262.  
  263. For Emacs-style editing on the command-line see |emacs-keys|.
  264.  
  265. The <Up> and <Down> keys take the current command-line as a search string.
  266. The beginning of the next/previous command-lines are compared with this
  267. string.  The first line that matches is the new command-line.  When typing
  268. these two keys repeatedly, the same string is used again.  For example, this
  269. can be used to find the previous substitute command: Type ":s" and then <Up>.
  270. The same could be done by typing <S-Up> a number of times until the desired
  271. command-line is shown.  (Note: the shifted arrow keys do not work on all
  272. terminals)
  273.  
  274.                             *his* *:history*
  275. :his[tory]    Print the history of last entered commands.
  276.         {not in Vi}
  277.         {not available when compiled without the |+cmdline_hist|
  278.         feature}
  279.  
  280. :his[tory] [{name}] [{first}][, [{last}]]
  281.         List the contents of history {name} which can be:
  282.         c[md]     or :    command-line history
  283.         s[earch] or /    search string history
  284.         e[xpr]     or =    expression register history
  285.         i[nput]     or @    input line history
  286.         a[ll]        all of the above
  287.         {not in Vi}
  288.  
  289.         If the numbers {first} and/or {last} are given, the respective
  290.         range of entries from a history is listed.  These numbers can
  291.         be specified in the following form:
  292.                             *:history-indexing*
  293.         A positive number represents the absolute index of an entry
  294.         as it is given in the first column of a :history listing.
  295.         This number remains fixed even if other entries are deleted.
  296.  
  297.         A negative number means the relative position of an entry,
  298.         counted from the newest entry (which has index -1) backwards.
  299.  
  300.         Examples:
  301.         List entries 6 to 12 from the search history: >
  302.             :history / 6,12
  303. <
  304.         List the recent five entries from all histories: >
  305.             :history all -5,
  306.  
  307. ==============================================================================
  308. 2. Command-line completion                *cmdline-completion*
  309.  
  310. When editing the command-line, a few commands can be used to complete the
  311. word before the cursor.  This is available for:
  312.  
  313. - Command names: At the start of the command-line.
  314. - Tags: Only after the ":tag" command.
  315. - File names: Only after a command that accepts a file name or a setting for
  316.   an option that can be set to a file name.  This is called file name
  317.   completion.
  318. - Options: Only after the ":set" command.
  319. - Mappings: Only after a ":map" or similar command.
  320. - Variable and function names: Only after a ":if", ":call" or similar command.
  321.  
  322. When Vim was compiled with the |+cmdline_compl| feature disabled, only file
  323. names, directories and help items can be completed.
  324.  
  325. These are the commands that can be used:
  326.  
  327.                             *c_CTRL-D*
  328. CTRL-D        List names that match the pattern in front of the cursor.
  329.         When showing file names, directories are highlighted (see
  330.         'highlight' option).  Names where 'suffixes' matches are moved
  331.         to the end.
  332.                     *c_CTRL-I* *c_wildchar* *c_<Tab>*
  333. 'wildchar' option
  334.         A match is done on the pattern in front of the cursor.  The
  335.         match (if there are several, the first match) is inserted
  336.         in place of the pattern.  (Note: does not work inside a
  337.         macro, because <Tab> or <Esc> are mostly used as 'wildchar',
  338.         and these have a special meaning in some macros.) When typed
  339.         again and there were multiple matches, the next
  340.         match is inserted.  After the last match, the first is used
  341.         again (wrap around).
  342.         The behavior can be changed with the 'wildmode' option.
  343.                             *c_CTRL-N*
  344. CTRL-N        After using 'wildchar' which got multiple matches, go to next
  345.         match.  Otherwise recall more recent command-line from history.
  346. <S-Tab>                            *c_CTRL-P* *c_<S-Tab>*
  347. CTRL-P        After using 'wildchar' which got multiple matches, go to
  348.         previous match.  Otherwise recall older command-line from
  349.         history.  <S-Tab> only works with the GUI, on the Amiga and
  350.         with MS-DOS.
  351.                             *c_CTRL-A*
  352. CTRL-A        All names that match the pattern in front of the cursor are
  353.         inserted.
  354.                             *c_CTRL-L*
  355. CTRL-L        A match is done on the pattern in front of the cursor.  If
  356.         there is one match, it is inserted in place of the pattern.
  357.         If there are multiple matches the longest common part is
  358.         inserted in place of the pattern.  If the result is shorter
  359.         than the pattern, no completion is done.
  360.  
  361. The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
  362. a previous version <Esc> was used).  In the pattern standard wildcards '*' and
  363. '?' are accepted.  '*' matches any string, '?' matches exactly one character.
  364.  
  365. If you like tcsh's autolist completion, you can use this mapping:
  366.     :cnoremap X <C-L><C-D>
  367. (Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
  368. This will find the longest match and then list all matching files.
  369.  
  370. If you like tcsh's autolist completion, you can use the 'wildmode' option to
  371. emulate it.  For example, this mimics autolist=ambiguous:
  372.     :set wildmode=longest,list
  373. This will find the longest match with the first 'wildchar', then list all
  374. matching files with the next.
  375.  
  376.                             *suffixes*
  377. For file name completion you can use the 'suffixes' option to set a priority
  378. between files with almost the same name.  If there are multiple matches,
  379. those files with an extension that is in the 'suffixes' option are ignored.
  380. The default is ".bak,~,.o,.h,.info,.swp", which means that files ending in
  381. ".bak", "~", ".o", ".h", ".info" and ".swp" are sometimes ignored.  It is
  382. impossible to ignore suffixes with two dots.  Examples:
  383.  
  384.   pattern:    files:                match:    ~
  385.    test*    test.c test.h test.o        test.c
  386.    test*    test.h test.o            test.h and test.o
  387.    test*    test.i test.h test.c        test.i and test.c
  388.  
  389. If there is more than one matching file (after ignoring the ones matching
  390. the 'suffixes' option) the first file name is inserted.  You can see that
  391. there is only one match when you type 'wildchar' twice and the completed
  392. match stays the same.  You can get to the other matches by entering
  393. 'wildchar', CTRL-N or CTRL-P.  All files are included, also the ones with
  394. extensions matching the 'suffixes' option.
  395.  
  396. To completely ignore files with some extension use 'wildignore'.
  397.  
  398. The old value of an option can be obtained by hitting 'wildchar' just after
  399. the '='.  For example, typing 'wildchar' after ":set dir=" will insert the
  400. current value of 'dir'.  This overrules file name completion for the options
  401. that take a file name.
  402.  
  403. If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
  404. your .cshrc: >
  405.     xmodmap -e "keysym Tab = Tab Find"
  406. And this in your .vimrc: >
  407.     :cmap <Esc>[1~ <C-P>
  408.  
  409. ==============================================================================
  410. 3. Ex command-lines                    *cmdline-lines*
  411.  
  412. The Ex commands have a few specialties:
  413.  
  414.                             *:quote*
  415. '"' at the start of a line causes the whole line to be ignored.  '"'
  416. after a command causes the rest of the line to be ignored.  This can be used
  417. to add comments.  Example: >
  418.     :set ai        "set 'autoindent' option
  419. It is not possible to add a comment to a shell command ":!cmd" or to the
  420. ":map" command and friends, because they see the '"' as part of their
  421. argument.
  422.  
  423.                             *:bar* *:\bar*
  424. '|' can be used to separate commands, so you can give multiple commands in one
  425. line.  If you want to use '|' in an argument, precede it with '\'.
  426.  
  427. These commands see the '|' as their argument, and can therefore not be
  428. followed by another command:
  429.     :argdo
  430.     :autocmd
  431.     :bufdo
  432.     :command
  433.     :cscope
  434.     :debug
  435.     :folddoopen
  436.     :folddoclosed
  437.     :global
  438.     :help
  439.     :helpfind
  440.     :make
  441.     :normal
  442.     :perl
  443.     :perldo
  444.     :promptfind
  445.     :promptrepl
  446.     :pyfile
  447.     :python
  448.     :registers
  449.     :read !
  450.     :scscope
  451.     :tcl
  452.     :tcldo
  453.     :tclfile
  454.     :vglobal
  455.     :windo
  456.     :write !
  457.     :[range]!
  458.     a user defined command without the "-bar" argument |:command|
  459.  
  460. Note that this is confusing (inherited from Vi): With ":g" the '|' is included
  461. in the command, with ":s" it is not.
  462.  
  463. To be able to use another command anyway, use the ":execute" command.
  464. Example (append the output of "ls" and jump to the first line): >
  465.     :execute 'r !ls' | '[
  466.  
  467. There is one exception: When the 'b' flag is present in 'cpoptions', with the
  468. ":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
  469. '\'.  You can also use "<Bar>" instead.  See also |map_bar|.
  470.  
  471. Examples: >
  472.     :!ls | wc        view the output of two commands
  473.     :r !ls | wc        insert the same output in the text
  474.     :%g/foo/p|>        moves all matching lines one shiftwidth
  475.     :%s/foo/bar/|>        moves one line one shiftwidth
  476.     :map q 10^V|        map "q" to "10|"
  477.     :map q 10\| map \ l    map "q" to "10\" and map "\" to "l"
  478.                     (when 'b' is present in 'cpoptions')
  479.  
  480. You can also use <NL> to separate commands in the same way as with '|'.  To
  481. insert a <NL> use CTRL-V CTRL-J.  "^@" will be shown.  Using '|' is the
  482. preferred method.  But for external commands a <NL> must be used, because a
  483. '|' is included in the external command.  To avoid the special meaning of <NL>
  484. it must be preceded with a backslash.  Example: >
  485.     :r !date<NL>-join
  486. This reads the current date into the file and joins it with the previous line.
  487.  
  488. Note that when the command before the '|' generates an error, the following
  489. commands will not be executed.
  490.  
  491.  
  492. Because of Vi compatibility the following strange commands are supported: >
  493.     :|            print current line (like ":p")
  494.     :3|            print line 3 (like ":3p")
  495.     :3            goto line 3
  496.  
  497. A colon is allowed between the range and the command name.  It is ignored
  498. (this is Vi compatible).  For example: >
  499.     :1,$:s/pat/string
  500.  
  501. When the character '%' or '#' is used where a file name is expected, they are
  502. expanded to the current and alternate file name (see the chapter "editing
  503. files" |:_%| |:_#|).
  504.  
  505. Embedded spaces in file names are allowed on the Amiga if one file name is
  506. expected as argument.  Trailing spaces will be ignored, unless escaped with a
  507. backslash or CTRL-V.  Note that the ":next" command uses spaces to separate
  508. file names.  Escape the spaces to include them in a file name.  Example: >
  509.     :next foo\ bar goes\ to school\
  510. starts editing the three files "foo bar", "goes to" and "school ".
  511.  
  512. When you want to use the special characters '"' or '|' in a command, or want
  513. to use '%' or '#' in a file name, precede them with a backslash.  The
  514. backslash is not required in a range and in the ":substitute" command.
  515.  
  516.                             *:_!*
  517. The '!' (bang) character after an Ex command makes the command behave in a
  518. different way.  The '!' should be placed immediately after the command, without
  519. any blanks in between.  If you insert blanks the '!' will be seen as an
  520. argument for the command, which has a different meaning.  For example:
  521.     :w! name    write the current buffer to file "name", overwriting
  522.             any existing file
  523.     :w !name    send the current buffer as standard input to command
  524.             "name"
  525.  
  526. ==============================================================================
  527. 4. Ex command-line ranges        *cmdline-ranges* *[range]* *E16*
  528.  
  529. Some Ex commands accept a line range in front of them.  This is noted as
  530. [range].  It consists of one or more line specifiers, separated with ',' or
  531. ';'.
  532.  
  533. The basics are explained in section |10.3| of the user manual.
  534.  
  535.                         *:,* *:;*
  536. When separated with ';' the cursor position will be set to that line
  537. before interpreting the next line specifier.  This doesn't happen for ','.
  538. Examples: >
  539.    4,/this line/
  540. <    from line 4 till match with "this line" after the cursor line. >
  541.    5;/that line/
  542. <    from line 5 till match with "that line" after line 5.
  543.  
  544. The default line specifier for most commands is the cursor position, but the
  545. commands ":write" and ":global" have the whole file (1,$) as default.
  546.  
  547. If more line specifiers are given than required for the command, the first
  548. one(s) will be ignored.
  549.  
  550. Line numbers may be specified with:            *:range* *E14*
  551.     {number}    an absolute line number
  552.     .        the current line              *:.*
  553.     $        the last line in the file          *:$*
  554.     %        equal to 1,$ (the entire file)          *:%*
  555.     't        position of mark t (lowercase)          *:'*
  556.     /{pattern}[/]    the next line where {pattern} matches      *:/*
  557.     ?{pattern}[?]    the previous line where {pattern} matches *:?*
  558.     \/        the next line where the previously used search
  559.             pattern matches
  560.     \?        the previous line where the previously used search
  561.             pattern matches
  562.     \&        the next line where the previously used substitute
  563.             pattern matches
  564.  
  565. Each may be followed (several times) by '+' or '-' and an optional number.
  566. This number is added or subtracted from the preceding line number.  If the
  567. number is omitted, 1 is used.
  568.  
  569. The "/" and "?" after {pattern} are required to separate the pattern from
  570. anything that follows.
  571.  
  572. The "/" and "?" may be preceded with another address.  The search starts from
  573. there.  The difference from using ';' is that the cursor isn't moved.
  574. Examples: >
  575.     /pat1//pat2/    Find line containing "pat2" after line containing
  576.             "pat1", without moving the cursor.
  577.     7;/pat2/    Find line containing "pat2", after line 7, leaving
  578.             the cursor in line 7.
  579.  
  580. The {number} must be between 0 and the number of lines in the file.  When
  581. using a 0 (zero) this is interpreted as a 1 by most commands.  Commands that
  582. use it as a count do use it as a zero (|:tag|, |:pop|, etc).  Some commands
  583. interpret the zero as "before the first line" (|:read|, search pattern, etc).
  584.  
  585. Examples: >
  586.     .+3        three lines below the cursor
  587.     /that/+1    the line below the next line containing "that"
  588.     .,$        from current line until end of file
  589.     0;/that        the first line containing "that", also matches in the
  590.             first line.
  591.     1;/that        the first line after line 1 containing "that"
  592.  
  593. Some commands allow for a count after the command.  This count is used as the
  594. number of lines to be used, starting with the line given in the last line
  595. specifier (the default is the cursor line).  The commands that accept a count
  596. are the ones that use a range but do not have a file name argument (because
  597. a file name can also be a number).
  598.  
  599. Examples: >
  600.     :s/x/X/g 5    substitute 'x' by 'X' in the current line and four
  601.             following lines
  602.     :23d 4        delete lines 23, 24, 25 and 26
  603.  
  604. A range should have the lower line number first.  If this is not the case, Vim
  605. will ask you if it should swap the line numbers.  This is not done within the
  606. global command ":g".
  607.  
  608.                             *N:*
  609. When giving a count before entering ":", this is translated into:
  610.         :.,.+(count - 1)
  611. In words: The 'count' lines at and after the cursor.  Example: To delete
  612. three lines: >
  613.         3:d<CR>        is translated into: .,.+2d<CR>
  614. <
  615.                             *v_:*
  616. {Visual}:    Starts a command-line with the Visual selected lines as a
  617.         range.  The code ":'<,'>" is used for this range, which makes
  618.         it possible to select a similar line from the command-line
  619.         history for repeating a command on different Visually selected
  620.         lines.
  621.  
  622. ==============================================================================
  623. 5. Ex special characters                *cmdline-special*
  624.  
  625. In Ex commands, at places where a file name can be used, the following
  626. characters have a special meaning.  These can also be used in the expression
  627. function expand() |expand()|.
  628.     %    is replaced with the current file name            *:_%*
  629.     #    is replaced with the alternate file name        *:_#*
  630.     #n    (where n is a number) is replaced with the file name of
  631.         buffer n.  "#0" is the same as "#"
  632.     ##    is replaced with all names in the argument list        *:_##*
  633.         concatenated, separated by spaces.  Each space in a name
  634.         is preceded with a backslash.
  635. Note that these give the file name as it was typed.  If an absolute path is
  636. needed (when using the file name from a different directory), you need to add
  637. ":p".  See |filename-modifiers|.
  638.  
  639. To avoid the special meaning of '%' and '#' insert a backslash before it.
  640. Detail: The special meaning is always escaped when there is a backslash before
  641. it, no matter how many backslashes.
  642.     you type:        result    ~
  643.        #            alternate.file
  644.        \#            #
  645.        \\#            \#
  646.  
  647.                    *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
  648.                    *:<sfile>* *<sfile>* *:<afile>* *<afile>*
  649.                    *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
  650. Note: these are typed literally, they are not special keys!
  651.     <cword>    is replaced with the word under the cursor (like |star|)
  652.     <cWORD>    is replaced with the WORD under the cursor (see |WORD|)
  653.     <cfile>    is replaced with the path name under the cursor (like what
  654.            |gf| uses)
  655.     <afile>    when executing autocommands, is replaced with the file name
  656.            for a file read or write
  657.     <abuf>     when executing autocommands, is replaced with the currently
  658.            effective buffer number (for ":r file" it is the current
  659.            buffer, the file being read is not in a buffer).
  660.     <amatch>   when executing autocommands, is replaced with the match for
  661.            which this autocommand was executed.  It differs form
  662.            <afile> only when the file name isn't used to match with
  663.            (for FileType and Syntax events).
  664.     <sfile>    when executing a ":source" command, is replaced with the
  665.            file name of the sourced file;
  666.            when executing a function, is replaced with
  667.            "function {function-name}"; function call nesting is
  668.            indicated like this:
  669.            "function {function-name1}->{function-name2}".  Note that
  670.            filename-modifiers are useless when <sfile> is used inside
  671.            a function.
  672.  
  673.                              *filename-modifiers*
  674.          *:_%:* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs*
  675. The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
  676. "<afile>" or "<abuf>".  They are also used with the |fnamemodify()| function.
  677. These are not available when Vim has been compiled without the |+modify_fname|
  678. feature.
  679. These modifiers can be given, in this order:
  680.     :p    Make file name a full path.  Must be the first modifier.  If
  681.         the name is a directory a path separator is added at the end.
  682.     :~    Reduce file name to be relative to the home directory, if
  683.         possible.  File name is unmodified if it is not below the home
  684.         directory.
  685.     :.    Reduce file name to be relative to current directory, if
  686.         possible.  File name is unmodified if it is not below the
  687.         current directory.
  688.         For maximum shortness, use ":~:.".
  689.     :h    Head of the file name (the last component and any separators
  690.         removed).  Cannot be used with :e, :r or :t.
  691.         Can be repeated to remove several components at the end.
  692.         When the file name ends in a path separator, only the path
  693.         separator is removed.  Thus ":p:h" on a directory name results
  694.         on the directory name itself (without trailing slash).
  695.         When the file name is an absolute path (starts with "/" for
  696.         Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
  697.         part is not removed.  When there is no head (path is relative
  698.         to current directory) the result is empty.
  699.     :t    Tail of the file name (last component of the name).  Must
  700.         precede any :r or :e.
  701.     :r    Root of the file name (the last extension removed).  When
  702.         there is only an extension (file name that starts with '.',
  703.         e.g., ".vimrc"), it is not removed.  Can be repeated to remove
  704.         several extensions (last one first).
  705.     :e    Extension of the file name.  Only makes sense when used alone.
  706.         When there is no extension the result is empty.
  707.         When there is only an extension (file name that starts with
  708.         '.'), the result is empty.  Can be repeated to include more
  709.         extensions.  If there are not enough extensions (but at least
  710.         one) as much as possible are included.
  711.     :s?pat?sub?
  712.         Substitute the first occurrence of "pat" with "sub".  This
  713.         works like the |:s| command.  "pat" is a regular expression.
  714.         Any character can be used for '?', but it must not occur in
  715.         "pat" or "sub".
  716.         After this, the previous modifiers can be used again.  For
  717.         example ":p", to make a full path after the substitution.
  718.     :gs?pat?sub?
  719.         Substitute all occurrences of "path" with "sub".  Otherwise
  720.         this works like ":s".
  721.  
  722. Examples, when the file name is "src/version.c", current dir
  723. "/home/mool/vim": >
  724.   :p            /home/mool/vim/src/version.c
  725.   :p:.                       src/version.c
  726.   :p:~                 ~/vim/src/version.c
  727.   :h                       src
  728.   :p:h            /home/mool/vim/src
  729.   :p:h:h        /home/mool/vim
  730.   :t                       version.c
  731.   :p:t                       version.c
  732.   :r                       src/version
  733.   :p:r            /home/mool/vim/src/version
  734.   :t:r                       version
  735.   :e                           c
  736.   :s?version?main?               src/main.c
  737.   :s?version?main?:p    /home/mool/vim/src/main.c
  738.   :p:gs?/?\\?        \home\mool\vim\src\version.c
  739.  
  740. Examples, when the file name is "src/version.c.gz": >
  741.   :p            /home/mool/vim/src/version.c.gz
  742.   :e                             gz
  743.   :e:e                           c.gz
  744.   :e:e:e                       c.gz
  745.   :e:e:r                       c
  746.   :r                       src/version.c
  747.   :r:e                           c
  748.   :r:r                       src/version
  749.   :r:r:r                   src/version
  750. <
  751.                     *extension-removal* *:_%<*
  752. If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
  753. name is removed (everything after and including the last '.' in the file
  754. name).  This is included for backwards compatibility with version 3.0, the
  755. ":r" form is preferred.  Examples: >
  756.  
  757.     %        current file name
  758.     %<        current file name without extension
  759.     #        alternate file name for current window
  760.     #<        idem, without extension
  761.     #31        alternate file number 31
  762.     #31<        idem, without extension
  763.     <cword>        word under the cursor
  764.     <cWORD>        WORD under the cursor (see |WORD|)
  765.     <cfile>        path name under the cursor
  766.     <cfile><    idem, without extension
  767.  
  768. Note: Where a file name is expected wildcards expansion is done.  On Unix the
  769. shell is used for this, unless it can be done internally (for speed).
  770. Backticks also work, like in >
  771.     :n `echo *.c`
  772. (backtick expansion is not possible in |restricted-mode|)
  773. But expansion is only done if there are any wildcards before expanding the
  774. '%', '#', etc..  This avoids expanding wildcards inside a file name.  If you
  775. want to expand the result of <cfile>, add a wildcard character to it.
  776. Examples: (alternate file name is "?readme?")
  777.     command        expands to  ~
  778.     :e #        :e ?readme?
  779.     :e `ls #`    :e {files matching "?readme?"}
  780.     :e #.*        :e {files matching "?readme?.*"}
  781.     :cd <cfile>    :cd {file name under cursor}
  782.     :cd <cfile>*    :cd {file name under cursor plus "*" and then expanded}
  783.  
  784. When the expanded argument contains a "!" and it is used for a shell command
  785. (":!cmd", ":r !cmd" or ":w !cmd"), it is escaped with a backslash to avoid it
  786. being expanded into a previously used command.  When the 'shell' option
  787. contains "sh", this is done twice, to avoid the shell trying to expand the
  788. "!".
  789.  
  790.                             *filename-backslash*
  791. For filesystems that use a backslash as directory separator (MS-DOS, Windows,
  792. OS/2), it's a bit difficult to recognize a backslash that is used to escape
  793. the special meaning of the next character.  The general rule is: If the
  794. backslash is followed by a normal file name character, it does not have a
  795. special meaning.  Therefore "\file\foo" is a valid file name, you don't have
  796. to type the backslash twice.
  797.  
  798. An exception is the '$' sign.  It is a valid character in a file name.  But
  799. to avoid a file name like "$home" to be interpreted as an environment variable,
  800. it needs to be preceded by a backslash.  Therefore you need to use "/\$home"
  801. for the file "$home" in the root directory.  A few examples:
  802.  
  803.     FILE NAME    INTERPRETED AS    ~
  804.     $home        expanded to value of environment var $home
  805.     \$home        file "$home" in current directory
  806.     /\$home        file "$home" in root directory
  807.     \\$home        file "\\", followed by expanded $home
  808.  
  809. ==============================================================================
  810. 6. Command-line window                *cmdline-window* *cmdwin*
  811.  
  812. In the command-line window the command line can be edited just like editing
  813. text in any window.  It is a special kind of window, because you cannot leave
  814. it in a normal way.
  815. {not available when compiled without the |+cmdline_hist| or |+vertsplit|
  816. feature}
  817.  
  818.  
  819. OPEN
  820.  
  821. There are two ways to open the command-line window:
  822. 1. From Command-line mode, use the key specified with the 'cedit' option.
  823.    The default is CTRL-F when 'compatible' is not set.
  824. 2. From Normal mode, use the "q:", "q/" or "q?" command.  *q:* *q/* *q?*
  825.    This starts editing an Ex command-line ("q:") or search string ("q/" or
  826.    "q?").  Note that this is not possible while recording is in progress (the
  827.    "q" stops recording then).
  828.  
  829. When the window opens it is filled with the command-line history.  The last
  830. line contains the command as typed so far.  The left column will show a
  831. character that indicates the type of command-line being edited, see
  832. |cmdwin-char|.
  833.  
  834. Vim will be in Normal mode when the editor is opened, except when 'insertmode'
  835. is set.
  836.  
  837. The height of the window is specified with 'cmdwinheight' (or smaller if there
  838. is no room).  The window is always full width and is positioned just above the
  839. command-line.
  840.  
  841.  
  842. EDIT
  843.  
  844. You can now use commands to move around and edit the text in the window.  Both
  845. in Normal mode and Insert mode.
  846.  
  847. It is possible to use ":", "/" and other commands that use the command-line,
  848. but it's not possible to open another command-line window then.  There is no
  849. nesting.
  850.                             *E11*
  851. It is not possible to move to another window or edit another buffer.  All
  852. commands that would do this are disabled in the command-line window.
  853.  
  854.  
  855. CLOSE                            *E199*
  856.  
  857. There are three ways to leave the command-line window:
  858.  
  859. <CR>        Execute the command-line under the cursor.  Works both in
  860.         Insert and in Normal mode.
  861. CTRL-C        Continue in Command-line mode.  The command-line under the
  862.         cursor is used as the command-line.  Works both in Insert and
  863.         in Normal mode.  ":close" also works.  There is no redraw,
  864.         thus the window will remain visible.
  865. :quit        Discard the command line and go back to Normal mode.
  866.         ":exit", ":xit" and CTRL-\ CTRL-N also work.
  867. :qall        Quit Vim, unless there are changes in some buffer.
  868. :qall!        Quit Vim, discarding changes to any buffer.
  869.  
  870. Once the command-line window is closed the old window sizes are restored.  The
  871. executed command applies to the window and buffer where the command-line was
  872. started from.  This works as if the command-line window was not there, except
  873. that there will be an extra screen redraw.
  874. The buffer used for the command-line window is deleted.  Any changes to lines
  875. other than the one that is executed with <CR> are lost.
  876.  
  877.  
  878. VARIOUS
  879.  
  880. The command-line window cannot be used:
  881. - when there already is a command-line window (no nesting)
  882. - for entering a encryption key or when using inputsecret()
  883. - when Vim was not compiled with the +vertsplit feature
  884.  
  885. Some options are set when the command-line window is opened:
  886. 'filetype'    "vim", when editing an Ex command-line; this starts Vim syntax
  887.         highlighting if it was enabled
  888. 'rightleft'    off
  889. 'modifiable'    on
  890. 'buftype'    "nofile"
  891. 'swapfile'    off
  892.  
  893. It is allowed to write the buffer contents to a file.  This is an easy way to
  894. save the command-line history and read it back later.
  895.  
  896. If the 'wildchar' option is set to <Tab>, and the command-line window is used
  897. for an Ex command, then two mappings will be added to use <Tab> for completion
  898. in the command-line window, like this: >
  899.     :imap <buffer> <Tab> <C-X><C-V>
  900.     :nmap <buffer> <Tab> a<C-X><C-V>
  901. Note that hitting <Tab> in Normal mode will do completion on the next
  902. character.  That way it works at the end of the line.
  903. If you don't want these mappings, disable them with: >
  904.     au CmdwinEnter [:>] iunmap <Tab>
  905.     au CmdwinEnter [:>] nunmap <Tab>
  906. You could put these lines in your vimrc file.
  907.  
  908. While in the command-line window you cannot use the mouse to put the cursor in
  909. another window, or drag statuslines of other windows.  You can drag the
  910. statusline of the command-line window itself.  If you drag it all the way up,
  911. the statusline of the window above it will move, thus creating more room in
  912. the command-line window.
  913.  
  914.  
  915. AUTOCOMMANDS
  916.  
  917. Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|.  Since this
  918. window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
  919. events are not triggered.  You can use the Cmdwin events to do settings
  920. specifically for the command-line window.  Be careful not to cause side
  921. effects!
  922. Example: >
  923.     :au CmdwinEnter :  let b:cpt_save = &cpt | set cpt=v
  924.     :au CmdwinLeave :  let &cpt = b:cpt_save
  925. This sets 'complete' to use command-line completion in Insert mode for CTRL-N.
  926. Another example: >
  927.     :au CmdwinEnter [/?]  startinsert
  928. This will make Vim start in Insert mode in the command-line window.
  929.  
  930.                         *cmdwin-char*
  931. The character used for the pattern indicates the type of command-line:
  932.     :    normal Ex command
  933.     >    debug mode command |debug-mode|
  934.     /    forward search string
  935.     ?    backward search string
  936.     =    expression for "= |expr-register|
  937.     @    string for |input()|
  938.     -    text for |:insert| or |:append|
  939.  
  940.  vim:tw=78:ts=8:ft=help:norl:
  941.